.\" $Id$
.\"
.\" Copyright (c) 2004 Damien Miller <djm@mindrot.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd July 30, 2004
.Dt FLOWD 8
.Os
.Sh NAME
.Nm flowd
.Nd NetFlow collector daemon
.Sh SYNOPSIS
.Nm flowd
.Op Fl hdg
.Oo Fl D
.Ar macro Ns = Ns Ar value Oc
.Op Fl f Ar config_file
.Ar command
.Sh DESCRIPTION
.Nm
is a small NetFlow collector daemon capable of understanding Cisco NetFlow
version 1, version 5 and version 9 packet formats.
.Nm
supports filtering and tagging of received flows before they are stored on
disk, using a filter syntax similar to the OpenBSD PF packet filter.
The on-disk format is flexible in that it allows selection of which packet
fields are recorded, so logs may be made very compact.
.Pp
By default,
.Nm
will obtain its configuration from the
.Xr flowd.conf 5
file, which typically resides in
.Pa @CONFPATH@/flowd.conf .
However, a different configuration file may be specified on the commandline
using the
.Fl d
option.
.Pp
.Nm
may be terminated by sending it a
.Dv SIGTERM
signal.
Upon receipt of a
.Dv SIGUSR1
.Nm
will close and reopen its logfile.
This is useful for rotating logs.
When
.Nm
receives a
.Dv SIGHUP
it will re-read its configuration and re-open its logfile.
Some basic runtime statistics will be logged when
.Nm
is signalled with
.Dv SIGUSR2
or
.Dv SIGINFO .
.Pp
The command-line options are as follows:
.Bl -tag -width Ds
.It Fl D Ar macro Ns = Ns Ar value
defines the name macro, which can then be used later in the config file.
Refer to the
.Cm MACROS
section in
.Xr flowd.conf 5
for more information on the use of macros.
.It Fl d
Places
.Nm
in debugging mode.
In this mode,
.Nm
will not fork to the background and will print verbose diagnostics, including
details of each flow received.
.It Fl g
Causes
.Nm
not to fork and background itself.
Logging will be reported to stderr instead of syslog.
.It Fl f Ar config_file
Specify an alternate location for the configuration file
Default is
.Pa @CONFPATH@/flowd.conf
.It Fl h
Displays commandline usage information.
.El
.Sh AUTHORS
Damien Miller <djm@mindrot.org>
.Sh SEE ALSO
.Xr flowd-reader 8
.Xr flowd.conf 5
